package org.jtb.quickr;

/**
 * Criteria for using the 
 * <CODE>ContactsService.getList()</CODE> method.
 * This class is a bean that encapsulates all service method arguments
 * in a type safe manner. 
 * For details, see the
 * <a href="http://www.flickr.com/services/api/flickr.contacts.getList.html">
 * flickr.contacts.getList service</a> documentation.
 *
 * @see org.jtb.quickr.ContactsService#getList(AuthResponse.Token,ContactsGetListCriteria)
 */
public class ContactsGetListCriteria {
    /**
     * Filter.
     */
    public enum Filter {
        FRIENDS ("friends"),
        FAMILY ("family"),
        BOTH ("both"),
        NEITHER ("neither");
        
        private String s;
        
        private Filter(String s) {
            this.s = s;
        }
        
        public String toString() {
            return s;
        }        
    }   
    
    private Integer page;
    private Integer perPage;
    private Filter filter;

    public Integer getPage() {
        return page;
    }

    public void setPage(Integer page) {
        this.page = page;
    }

    public Integer getPerPage() {
        return perPage;
    }

    public void setPerPage(Integer perPage) {
        this.perPage = perPage;
    }

    public Filter getFilter() {
        return filter;
    }

    public void setFilter(Filter filter) {
        this.filter = filter;
    }
    
}
